CallGetMarkTokenProc

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODSemanticInterface

CallGetMarkTokenProc
The CallGetMarkTokenProc method gets the mark token to use for marking a large series of objects.
void CallGetMarkTokenProc (in ODPart thePart, 
                           in ODOSLToken dContainerToken,
                           in ODDescType containerClass, 
                           in ODOSLToken result);
thePart
A reference to the part associated with this semantic interface object.
dContainerToken
A reference to the OpenDoc token that specifies the container of elements to be marked.
containerClass
The object class of the container for the desired objects.
result
A reference to the OpenDoc token to be used for marking the elements.

DISCUSSION
OpenDoc calls this method to obtain the mark token to pass to your semantic interface's CallMarkProc and CallAdjustMarksProc methods. The mark token you provide should contain information to uniquely identify the series of marked objects to your part.
Before OpenDoc can call this method, you must call your semantic interface object's SetOSlSupportFlags method and specify the flag kAEIDoMarking to indicate that your semantic interface supports marking. In general, your part should override the CallGetMarkTokenProc, CallMarkProc, and CallAdjustMarksProc methods in the following cases: it already supports the marking of objects or it expects to deal with large numbers of records that might not all fit into memory at once.

EXCEPTIONS
The Apple Event Manager may throw an exception if this method is unable to return an appropriate mark token.
This method may throw platform-specific exceptions.

SEE ALSO
The ODDescType type (page 925).
The ODSemanticInterface::CallAdjustMarksProc method (page 584).
The ODSemanticInterface::CallMarkProc method (page 593).
The ODSemanticInterface::SetOSLSupportFlags method (page 599).
The ODOSLToken class (page 456).